Skip to content

Type checker#527

Merged
GiovanniCanali merged 1 commit into
mathLab:devfrom
GiovanniCanali:type_check
Jun 11, 2025
Merged

Type checker#527
GiovanniCanali merged 1 commit into
mathLab:devfrom
GiovanniCanali:type_check

Conversation

@GiovanniCanali
Copy link
Copy Markdown
Collaborator

@GiovanniCanali GiovanniCanali commented Mar 27, 2025

Fixes #440: add a type checker to be used for debugging.

If the debugging level is set to DEBUG, the enforce_type decorator will enforce the type hints both for the decorated function's arguments and return value.

It requires type hints in the decorated function.

Example:

import logging

# Set logging level to DEBUG
logging.getLogger().setLevel(logging.DEBUG)

@enforce_types
def dummy_function(a: int, b: float) -> float:
    return a+b

# This  works
dummy_function(a=1, b=2.0)

# This raises a TypeError for the second argument
dummy_function(a=1, b=3)

# This raises a TypeError for the second argument
dummy_function(a=1, b="Hello, world!")

@GiovanniCanali GiovanniCanali added enhancement New feature or request pr-to-review Label for PR that are ready to been reviewed labels Mar 27, 2025
@GiovanniCanali GiovanniCanali self-assigned this Mar 27, 2025
@GiovanniCanali GiovanniCanali force-pushed the type_check branch 3 times, most recently from 64a9f0a to 9ef2f45 Compare March 27, 2025 16:05
@GiovanniCanali GiovanniCanali linked an issue Mar 31, 2025 that may be closed by this pull request
Static type checking for debugging #440
Closed
dario-coscia
dario-coscia reviewed Mar 31, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@dario-coscia dario-coscia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me looks good the structure, I am only wondering if we should merge it as it is or making it draft, update all files where we want type checking and then merge

@GiovanniCanali
Copy link
Copy Markdown
Collaborator Author

GiovanniCanali commented Mar 31, 2025

To me looks good the structure, I am only wondering if we should merge it as it is or making it draft, update all files where we want type checking and then merge

I share this doubt with you. As it is, this decorator is nice but cannot be used immediately, as we do not have any type suggestions in PINA. I see the following options:

  • We add type suggestions for all functions in the package, in order to be able to use the decorator whenever we need it.
  • We add type suggestions for all functions in the package, and use the decorator instead of hard coded checks.
  • We use the decorator only for code development. Once the code is ready and working, type checks are removed.

Of course, the second is an option only if the decorator is faster than hard coded checks, which I think might not be the case. The first one requires a lot of work, but I would be happy to contribute.

Let me know what you think about it, @dario-coscia!

@dario-coscia
Copy link
Copy Markdown
Collaborator

dario-coscia commented Apr 1, 2025

I

To me looks good the structure, I am only wondering if we should merge it as it is or making it draft, update all files where we want type checking and then merge

I share this doubt with you. As it is, this decorator is nice but cannot be used immediately, as we do not have any type suggestions in PINA. I see the following options:

  • We add type suggestions for all functions in the package, in order to be able to use the decorator whenever we need it.
  • We add type suggestions for all functions in the package, and use the decorator instead of hard coded checks.
  • We use the decorator only for code development. Once the code is ready and working, type checks are removed.

Of course, the second is an option only if the decorator is faster than hard coded checks, which I think might not be the case. The first one requires a lot of work, but I would be happy to contribute.

Let me know what you think about it, @dario-coscia!

The type checker only checks types, but the check_consistency function can be made more versatile in the future. However, type checking in debugging is very useful; maybe we can use it as a type checker, for example:

Line <line> of file <file> ===>  Entered in function <function name>, with input <input name> and input type <input type>
                                         ===>  Entered in ....
                                         ===>  Entered in ....
Line <line> of file <file> ===>  Entered in function <function name>, with input <input name> and input type <input type>
                                         ===>  Entered in ....

This way, it is by default turned off, but when debugging is enabled, it does the following. We can start thinking about adding it to the solver and see where it is also needed. Let's also listen to @ndem0 and @FilippoOlivo for this

@dario-coscia dario-coscia force-pushed the dev branch 2 times, most recently from a84b105 to a2b6c1f Compare April 14, 2025 09:44
@dario-coscia
Copy link
Copy Markdown
Collaborator

dario-coscia commented Apr 14, 2025

Maybe also related to #551 ? @GiovanniCanali what do you think?

@GiovanniCanali
Copy link
Copy Markdown
Collaborator Author

GiovanniCanali commented Apr 14, 2025

Maybe also related to #551 ? @GiovanniCanali what do you think?

Yes, definitively!

@GiovanniCanali GiovanniCanali merged commit 067fceb into mathLab:dev Jun 11, 2025
18 of 19 checks passed
dario-coscia added a commit that referenced this pull request Jun 13, 2025
@dario-coscia @FilippoOlivo
@GiovanniCanali @AleDinve
Dev Update (#582)
7bf7d34 
* Fix adaptive refinement (#571)


---------

Co-authored-by: Dario Coscia <93731561+dario-coscia@users.noreply.github.com>

* Remove collector

* Fixes

* Fixes

* rm unnecessary comment

* fix advection (#581)

* Fix tutorial .html link (#580)

* fix problem data collection for v0.1 (#584)

* Message Passing Module (#516)

* add deep tensor network block

* add interaction network block

* add radial field network block

* add schnet block

* add equivariant network block

* fix + tests + doc files

* fix egnn + equivariance/invariance tests

Co-authored-by: Dario Coscia <dariocos99@gmail.com>

---------

Co-authored-by: giovanni <giovanni.canali98@yahoo.it>
Co-authored-by: AleDinve <giuseppealessio.d@student.unisi.it>

* add type checker (#527)

---------

Co-authored-by: Filippo Olivo <filippo@filippoolivo.com>
Co-authored-by: Giovanni Canali <115086358+GiovanniCanali@users.noreply.github.com>
Co-authored-by: giovanni <giovanni.canali98@yahoo.it>
Co-authored-by: AleDinve <giuseppealessio.d@student.unisi.it>
@GiovanniCanali GiovanniCanali deleted the type_check branch August 28, 2025 07:59
GiovanniCanali added a commit to GiovanniCanali/PINA that referenced this pull request Dec 2, 2025
@dario-coscia @FilippoOlivo
@GiovanniCanali @AleDinve
Dev Update (mathLab#582)
bbc0257 
* Fix adaptive refinement (mathLab#571)


---------

Co-authored-by: Dario Coscia <93731561+dario-coscia@users.noreply.github.com>

* Remove collector

* Fixes

* Fixes

* rm unnecessary comment

* fix advection (mathLab#581)

* Fix tutorial .html link (mathLab#580)

* fix problem data collection for v0.1 (mathLab#584)

* Message Passing Module (mathLab#516)

* add deep tensor network block

* add interaction network block

* add radial field network block

* add schnet block

* add equivariant network block

* fix + tests + doc files

* fix egnn + equivariance/invariance tests

Co-authored-by: Dario Coscia <dariocos99@gmail.com>

---------

Co-authored-by: giovanni <giovanni.canali98@yahoo.it>
Co-authored-by: AleDinve <giuseppealessio.d@student.unisi.it>

* add type checker (mathLab#527)

---------

Co-authored-by: Filippo Olivo <filippo@filippoolivo.com>
Co-authored-by: Giovanni Canali <115086358+GiovanniCanali@users.noreply.github.com>
Co-authored-by: giovanni <giovanni.canali98@yahoo.it>
Co-authored-by: AleDinve <giuseppealessio.d@student.unisi.it>
GiovanniCanali added a commit to GiovanniCanali/PINA that referenced this pull request Dec 2, 2025
@dario-coscia @FilippoOlivo
@GiovanniCanali @AleDinve
Dev Update (mathLab#582)
e16e29b 
* Fix adaptive refinement (mathLab#571)


---------

Co-authored-by: Dario Coscia <93731561+dario-coscia@users.noreply.github.com>

* Remove collector

* Fixes

* Fixes

* rm unnecessary comment

* fix advection (mathLab#581)

* Fix tutorial .html link (mathLab#580)

* fix problem data collection for v0.1 (mathLab#584)

* Message Passing Module (mathLab#516)

* add deep tensor network block

* add interaction network block

* add radial field network block

* add schnet block

* add equivariant network block

* fix + tests + doc files

* fix egnn + equivariance/invariance tests

Co-authored-by: Dario Coscia <dariocos99@gmail.com>

---------

Co-authored-by: giovanni <giovanni.canali98@yahoo.it>
Co-authored-by: AleDinve <giuseppealessio.d@student.unisi.it>

* add type checker (mathLab#527)

---------

Co-authored-by: Filippo Olivo <filippo@filippoolivo.com>
Co-authored-by: Giovanni Canali <115086358+GiovanniCanali@users.noreply.github.com>
Co-authored-by: giovanni <giovanni.canali98@yahoo.it>
Co-authored-by: AleDinve <giuseppealessio.d@student.unisi.it>
GiovanniCanali added a commit to GiovanniCanali/PINA that referenced this pull request Dec 2, 2025
@dario-coscia @FilippoOlivo
@GiovanniCanali @AleDinve
Dev Update (mathLab#582)
184e551 
* Fix adaptive refinement (mathLab#571)


---------

Co-authored-by: Dario Coscia <93731561+dario-coscia@users.noreply.github.com>

* Remove collector

* Fixes

* Fixes

* rm unnecessary comment

* fix advection (mathLab#581)

* Fix tutorial .html link (mathLab#580)

* fix problem data collection for v0.1 (mathLab#584)

* Message Passing Module (mathLab#516)

* add deep tensor network block

* add interaction network block

* add radial field network block

* add schnet block

* add equivariant network block

* fix + tests + doc files

* fix egnn + equivariance/invariance tests

Co-authored-by: Dario Coscia <dariocos99@gmail.com>

---------

Co-authored-by: giovanni <giovanni.canali98@yahoo.it>
Co-authored-by: AleDinve <giuseppealessio.d@student.unisi.it>

* add type checker (mathLab#527)

---------

Co-authored-by: Filippo Olivo <filippo@filippoolivo.com>
Co-authored-by: Giovanni Canali <115086358+GiovanniCanali@users.noreply.github.com>
Co-authored-by: giovanni <giovanni.canali98@yahoo.it>
Co-authored-by: AleDinve <giuseppealessio.d@student.unisi.it>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dario-coscia dario-coscia dario-coscia left review comments

@ndem0 ndem0 ndem0 approved these changes

+1 more reviewer

@FilippoOlivo FilippoOlivo FilippoOlivo approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@GiovanniCanali GiovanniCanali

Labels

enhancement New feature or request pr-to-review Label for PR that are ready to been reviewed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Static type checking for debugging

4 participants

@GiovanniCanali @dario-coscia @ndem0 @FilippoOlivo